Get call details of all calls

This endpoint retrieves the call details of every call in the account. In practice you almost always narrow the collection with filter rather than requesting all of it: a setupTime range returns the calls of one period, and a callId or botConversationId looks up a single call whose identifier you already hold.

Endpoint

GET /api/v1/calls

Query parameters

Parameter Type Description
filter string Filters the call details by callId, setupTime, botConversationId, or text. See Filtering.
limit number Maximum number of call details to return per page. Maximum 200, default 100. See Pagination.
page number Which page of call details to return.
sort string Sorts the call details by a field. See Sorting.
showDeleted boolean Whether call details marked for deletion are included. false or 0 (default) excludes them, and true or 1 includes them.

Request

GET /api/v1/calls?page=1&limit=10&filter=(setupTime%3E%3D2022-11-30%2CsetupTime%3C2022-12-01T22%3A00%3A00.000Z)&sort=-setupTime HTTP/1.1
Host: livehub.audiocodes.io
Authorization: Bearer {token}

Response

200 OK — the call details, paginated. See Call detail fields for what each field holds.

{
  "calls": [
    {
      "callId": "7154ae6e-171a-47e7-a3c8-90085c6e1c5b",
      "callingEntity": {
        "id": "cc617142-e64c-474e-8023-3821472aebc0",
        "type": "sip-connection",
        "displayName": "my-sip-connection",
        "phoneNumber": "",
        "isTeams": false,
        "isClickToCall": false,
        "customizedInfo": "incoming%20test%20info%20%3C%20%3E%20%3D"
      },
      "calledEntity": {
        "id": "4e1f16c0-e132-42bb-8cdd-44de413304b9",
        "type": "bot",
        "displayName": "my-bot",
        "phoneNumber": "+15555550100",
        "isTeams": false,
        "customizedInfo": "outgoing%20test%20info%20%3C%20%3E%20%3D"
      },
      "ingressCallingNumber": "+15555550101",
      "egressCalledNumber": "+15555550102",
      "setupTime": "2022-12-04T10:28:16.2266667",
      "connectTime": "2022-12-04T10:28:16.4966667",
      "endTime": "2022-12-04T10:28:32.54",
      "successful": false,
      "durationSeconds": 16,
      "terminationDescription": "Recovery on timer expiry",
      "recorded": false,
      "botConversationId": "3dba30a5-ece4-47ae-99c2-101b7b5c015d",
      "globalSessionId": "f6ea8e6cbe312345",
      "statistics": {
        "sttAvgDelayMs": 759,
        "sttMaxDelayMs": 1129,
        "sttMedDelayMs": 701,
        "ttsAvgDelayMs": 1391,
        "ttsMaxDelayMs": 3114,
        "ttsMedDelayMs": 751,
        "botAvgDelayMs": 354,
        "botMaxDelayMs": 1643,
        "botMedDelayMs": 479
      }
    }
  ],
  "pages": {
    "size": 10,
    "total": 1,
    "current": 1,
    "totalElements": 1
  }
}